From 2b8707b010b0e81f8f95cdbb6558572cea04e7d9 Mon Sep 17 00:00:00 2001
From: Dan Nicholson <dbn@endlessos.org>
Date: Sun, 29 Jan 2023 09:28:31 -0700
Subject: [PATCH] bin: Cleanup documentation of --cache-dir option

In all cases documentation was missing from the manual and the bash
completion was incorrectly assigning it as a boolean option.
---
 bash/ostree                 | 12 ++++++------
 man/ostree-find-remotes.xml |  8 ++++++++
 man/ostree-pull.xml         |  8 ++++++++
 man/ostree-remote.xml       | 22 ++++++++++++++++++++++
 4 files changed, 44 insertions(+), 6 deletions(-)

diff --git a/bash/ostree b/bash/ostree
index 6f3b86ea..5958176f 100644
--- a/bash/ostree
+++ b/bash/ostree
@@ -900,7 +900,6 @@ _ostree_pull() {
     local boolean_options="
         $main_boolean_options
         --commit-metadata-only
-        --cache-dir
         --disable-fsync
         --disable-static-deltas
         --require-static-deltas
@@ -912,6 +911,7 @@ _ostree_pull() {
     "
 
     local options_with_args="
+        --cache-dir
         --depth
         --http-header
         --localcache-repo -L
@@ -925,7 +925,7 @@ _ostree_pull() {
     local options_with_args_glob=$( __ostree_to_extglob "$options_with_args" )
 
     case "$prev" in
-        --localcache-repo|-L|--repo|--subpath)
+        --cache-dir|--localcache-repo|-L|--repo|--subpath)
             __ostree_compreply_dirs_only
             return 0
             ;;
@@ -1274,17 +1274,17 @@ _ostree_remote_list_gpg_keys() {
 _ostree_remote_refs() {
     local boolean_options="
         $main_boolean_options
-        --cache-dir
     "
 
     local options_with_args="
+        --cache-dir
         --repo
     "
 
     local options_with_args_glob=$( __ostree_to_extglob "$options_with_args" )
 
     case "$prev" in
-        --repo)
+        --cache-dir|--repo)
             __ostree_compreply_dirs_only
             return 0
             ;;
@@ -1343,18 +1343,18 @@ _ostree_remote_show_url() {
 _ostree_remote_summary() {
     local boolean_options="
         $main_boolean_options
-        --cache-dir
         --raw
     "
 
     local options_with_args="
+        --cache-dir
         --repo
     "
 
     local options_with_args_glob=$( __ostree_to_extglob "$options_with_args" )
 
     case "$prev" in
-        --repo)
+        --cache-dir|--repo)
             __ostree_compreply_dirs_only
             return 0
             ;;
diff --git a/man/ostree-find-remotes.xml b/man/ostree-find-remotes.xml
index 5c5b2412..eee0d123 100644
--- a/man/ostree-find-remotes.xml
+++ b/man/ostree-find-remotes.xml
@@ -86,6 +86,14 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
         <title>Options</title>
 
         <variablelist>
+            <varlistentry>
+                <term><option>--cache-dir</option>=DIR</term>
+
+                <listitem><para>
+                    Use an alternate cache directory in <literal>DIR</literal>.
+                </para></listitem>
+            </varlistentry>
+
             <varlistentry>
                 <term><option>--disable-fsync</option></term>
 
diff --git a/man/ostree-pull.xml b/man/ostree-pull.xml
index 0915dd27..b86987ba 100644
--- a/man/ostree-pull.xml
+++ b/man/ostree-pull.xml
@@ -65,6 +65,14 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
                 </para></listitem>
             </varlistentry>
 
+            <varlistentry>
+                <term><option>--cache-dir</option>=DIR</term>
+
+                <listitem><para>
+                    Use an alternate cache directory in <literal>DIR</literal>.
+                </para></listitem>
+            </varlistentry>
+
             <varlistentry>
                 <term><option>--disable-fsync</option></term>
 
diff --git a/man/ostree-remote.xml b/man/ostree-remote.xml
index b14fc6d4..5b537a9f 100644
--- a/man/ostree-remote.xml
+++ b/man/ostree-remote.xml
@@ -194,6 +194,20 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
         </variablelist>
     </refsect1>
 
+    <refsect1>
+        <title>'Refs' Options</title>
+
+        <variablelist>
+            <varlistentry>
+                <term><option>--cache-dir</option>=DIR</term>
+
+                <listitem><para>
+                    Use an alternate cache directory in <literal>DIR</literal>.
+                </para></listitem>
+            </varlistentry>
+        </variablelist>
+    </refsect1>
+
     <refsect1>
         <title>'GPG-Import' Options</title>
 
@@ -226,6 +240,14 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
         <title>'Summary' Options</title>
 
         <variablelist>
+            <varlistentry>
+                <term><option>--cache-dir</option>=DIR</term>
+
+                <listitem><para>
+                    Use an alternate cache directory in <literal>DIR</literal>.
+                </para></listitem>
+            </varlistentry>
+
             <varlistentry>
                 <term><option>--raw</option></term>
 
-- 
2.30.2